home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 April: Mac OS SDK / Dev.CD Apr 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / AIncludes / OSUtils.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  12.1 KB  |  499 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        OSUtils.a
  3. ;
  4. ;    Contains:    OS Utilities Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1985-1998 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__OSUTILS__') = 'UNDEFINED' THEN
  18. __OSUTILS__ SET 1
  19.  
  20.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  21.     include 'MacTypes.a'
  22.     ENDIF
  23.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  24.     include 'MixedMode.a'
  25.     ENDIF
  26. ;   HandToHand and other memory utilties were moved to MacMemory.h 
  27.     IF &TYPE('__MACMEMORY__') = 'UNDEFINED' THEN
  28.     include 'MacMemory.a'
  29.     ENDIF
  30. ;   GetTrapAddress and other trap table utilties were moved to Patches.h 
  31.     IF &TYPE('__PATCHES__') = 'UNDEFINED' THEN
  32.     include 'Patches.a'
  33.     ENDIF
  34. ;   Date and Time utilties were moved to DateTimeUtils.h 
  35.     IF &TYPE('__DATETIMEUTILS__') = 'UNDEFINED' THEN
  36.     include 'DateTimeUtils.a'
  37.     ENDIF
  38.     IF ¬ TARGET_OS_MAC THEN
  39.     IF &TYPE('__ENDIAN__') = 'UNDEFINED' THEN
  40.     include 'Endian.a'
  41.     ENDIF
  42.     ENDIF
  43.  
  44. useFree                            EQU        0
  45. useATalk                        EQU        1
  46. useAsync                        EQU        2
  47. useExtClk                        EQU        3                    ;Externally clocked
  48. useMIDI                            EQU        4
  49.  
  50. false32b                        EQU        0                    ;24 bit addressing error
  51. true32b                            EQU        1                    ;32 bit addressing error
  52.  
  53.                                                             ; result types for RelString Call 
  54. sortsBefore                        EQU        -1                    ;first string < second string
  55. sortsEqual                        EQU        0                    ;first string = second string
  56. sortsAfter                        EQU        1                    ;first string > second string
  57.  
  58. dummyType                        EQU        0
  59. vType                            EQU        1
  60. ioQType                            EQU        2
  61. drvQType                        EQU        3
  62. evType                            EQU        4
  63. fsQType                            EQU        5
  64. sIQType                            EQU        6
  65. dtQType                            EQU        7
  66. nmType                            EQU        8
  67. ; typedef SignedByte                     QTypes
  68.  
  69. SysParmType                RECORD 0
  70. valid                     ds.b    1                ; offset: $0 (0)
  71. aTalkA                     ds.b    1                ; offset: $1 (1)
  72. aTalkB                     ds.b    1                ; offset: $2 (2)
  73. config                     ds.b    1                ; offset: $3 (3)
  74. portA                     ds.w    1                ; offset: $4 (4)
  75. portB                     ds.w    1                ; offset: $6 (6)
  76. alarm                     ds.l    1                ; offset: $8 (8)
  77. font                     ds.w    1                ; offset: $C (12)
  78. kbdPrint                 ds.w    1                ; offset: $E (14)
  79. volClik                     ds.w    1                ; offset: $10 (16)
  80. misc                     ds.w    1                ; offset: $12 (18)
  81. sizeof                     EQU *                    ; size:   $14 (20)
  82.                         ENDR
  83. ; typedef struct SysParmType *            SysPPtr
  84.  
  85. QElem                    RECORD 0
  86. qLink                     ds.l    1                ; offset: $0 (0)
  87. qType                     ds.w    1                ; offset: $4 (4)
  88. qData                     ds.w    1                ; offset: $6 (6) <-- really an array of length one
  89. sizeof                     EQU *                    ; size:   $8 (8)
  90.                         ENDR
  91. ; typedef struct QElem *                QElemPtr
  92.  
  93.     IF TARGET_OS_MAC THEN
  94. QHdr                    RECORD 0
  95. qFlags                     ds.w    1                ; offset: $0 (0)
  96. qHead                     ds.l    1                ; offset: $2 (2)
  97. qTail                     ds.l    1                ; offset: $6 (6)
  98. sizeof                     EQU *                    ; size:   $A (10)
  99.                         ENDR
  100. ; typedef struct QHdr *                    QHdrPtr
  101.  
  102.     ELSE
  103.  
  104. ;   QuickTime 3.0:
  105. ;   this version of QHdr contains the Mutex necessary for
  106. ;   non-mac non-interrupt code
  107.  
  108.  
  109. QHdr                    RECORD 0
  110. qFlags                     ds.w    1                ; offset: $0 (0)
  111. pad                         ds.w    1                ; offset: $2 (2)
  112. MutexID                     ds.l    1                ; offset: $4 (4)
  113. qHead                     ds.l    1                ; offset: $8 (8)
  114. qTail                     ds.l    1                ; offset: $C (12)
  115. sizeof                     EQU *                    ; size:   $10 (16)
  116.                         ENDR
  117. ; typedef struct QHdr *                    QHdrPtr
  118.  
  119.     ENDIF    ; TARGET_OS_MAC
  120.  
  121.  
  122. DeferredTask            RECORD 0
  123. qLink                     ds.l    1                ; offset: $0 (0)
  124. qType                     ds.w    1                ; offset: $4 (4)
  125. dtFlags                     ds.w    1                ; offset: $6 (6)
  126. dtAddr                     ds.l    1                ; offset: $8 (8)
  127. dtParam                     ds.l    1                ; offset: $C (12)
  128. dtReserved                 ds.l    1                ; offset: $10 (16)
  129. sizeof                     EQU *                    ; size:   $14 (20)
  130.                         ENDR
  131. ; typedef struct DeferredTask *            DeferredTaskPtr
  132.  
  133.     IF TARGET_OS_MAC THEN
  134. MachineLocation            RECORD 0
  135. latitude                 ds.l    1                ; offset: $0 (0)
  136. longitude                 ds.l    1                ; offset: $4 (4)
  137. dlsDelta                 ds.b    1                ; offset: $8 (8)        ;  signed byte; daylight savings delta 
  138.                          ORG 8
  139. gmtDelta                 ds.l    1                ; offset: $8 (8)        ;  use low 24-bits only 
  140. sizeof                     EQU *                    ; size:   $C (12)
  141.                         ENDR
  142.     ELSE
  143. ; 
  144. ;    QuickTime 3.0:
  145. ;    Alignment of MachineLocation is weird. The union above used for delta
  146. ;    tends not to work on non-Mac compilers.
  147. ;
  148.  
  149. MachineLocation            RECORD 0
  150. latitude                 ds.l    1                ; offset: $0 (0)
  151. longitude                 ds.l    1                ; offset: $4 (4)
  152. delta                     ds        BigEndianLong    ; offset: $8 (8)        ;  high byte is daylight savings delta, low 24-bits is GMT delta 
  153. sizeof                     EQU *                    ; size:   $C (12)
  154.                         ENDR
  155.     ENDIF    ; TARGET_OS_MAC
  156. ;
  157. ; pascal Boolean IsMetric(void )
  158. ;
  159.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  160.         Macro
  161.         _IsMetric
  162.             move.w              #$0004,-(sp)
  163.             dc.w                $A9ED
  164.         EndM
  165.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  166.         IMPORT_CFM_FUNCTION IsMetric
  167.     ENDIF
  168.  
  169. ;
  170. ; pascal SysPPtr GetSysPPtr(void )
  171. ;
  172.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  173.         Macro
  174.         _GetSysPPtr           &dest=(sp)
  175.             move.l            #$000001F8,&dest
  176.         EndM
  177.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  178.         IMPORT_CFM_FUNCTION GetSysPPtr
  179.     ENDIF
  180.  
  181.  
  182. ; 
  183. ;    NOTE: SysBeep() has been moved to Sound.h.  
  184. ;          We could not automatically #include Sound.h in this file
  185. ;          because Sound.h indirectly #include's OSUtils.h which
  186. ;          would make a circular include.
  187. ;
  188.  
  189. ;
  190. ; pascal OSErr DTInstall(DeferredTaskPtr dtTaskPtr)
  191. ;
  192.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  193.         ; parameters:
  194.         ;    dtTaskPtr       => A0
  195.         ; returns:
  196.         ;    OSErr           <= D0
  197.         _DTInstall:    OPWORD    $A082
  198.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  199.         IMPORT_CFM_FUNCTION DTInstall
  200.     ENDIF
  201.  
  202.  
  203.  
  204. ;
  205. ; pascal SInt8 GetMMUMode(void)
  206. ;
  207.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  208.         Macro
  209.         _GetMMUMode           &dest=(sp)
  210.             move.b            $0CB2,&dest
  211.         EndM
  212.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  213.         IMPORT_CFM_FUNCTION GetMMUMode
  214.     ENDIF
  215.  
  216. ;
  217. ; pascal SInt8 SwapMMUMode(SInt8 mode)
  218. ;
  219.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  220.         ; parameters:
  221.         ;    mode            => D0
  222.         ; returns:
  223.         ;    SInt8           <= D0
  224.         _SwapMMUMode:    OPWORD    $A05D
  225.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  226.         IMPORT_CFM_FUNCTION SwapMMUMode
  227.     ENDIF
  228.  
  229. ;
  230. ; pascal void Delay(unsigned long numTicks, unsigned long *finalTicks)
  231. ;
  232.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  233.         _Delay:    OPWORD    $A03B
  234.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  235.         IMPORT_CFM_FUNCTION Delay
  236.     ENDIF
  237.  
  238.  
  239. ;
  240. ; pascal OSErr WriteParam(void )
  241. ;
  242.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  243.         _WriteParam:    OPWORD    $A038
  244.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  245.         IMPORT_CFM_FUNCTION WriteParam
  246.     ENDIF
  247.  
  248. ;
  249. ; pascal void Enqueue(QElemPtr qElement, QHdrPtr qHeader)
  250. ;
  251.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  252.         ; parameters:
  253.         ;    qElement        => A0
  254.         ;    qHeader         => A1
  255.         _Enqueue:    OPWORD    $A96F
  256.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  257.         IMPORT_CFM_FUNCTION Enqueue
  258.     ENDIF
  259.  
  260. ;
  261. ; pascal OSErr Dequeue(QElemPtr qElement, QHdrPtr qHeader)
  262. ;
  263.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  264.         ; parameters:
  265.         ;    qElement        => A0
  266.         ;    qHeader         => A1
  267.         ; returns:
  268.         ;    OSErr           <= D0
  269.         _Dequeue:    OPWORD    $A96E
  270.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  271.         IMPORT_CFM_FUNCTION Dequeue
  272.     ENDIF
  273.  
  274. ;
  275. ; pascal OSErr InitUtil(void )
  276. ;
  277.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  278.         ; returns:
  279.         ;    OSErr           <= D0
  280.         _InitUtil:    OPWORD    $A03F
  281.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  282.         IMPORT_CFM_FUNCTION InitUtil
  283.     ENDIF
  284.  
  285.  
  286.     IF TARGET_CPU_PPC THEN
  287. ;
  288. ; pascal void MakeDataExecutable(void *baseAddress, unsigned long length)
  289. ;
  290.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  291.         IMPORT_CFM_FUNCTION MakeDataExecutable
  292.     ENDIF
  293.  
  294.     ENDIF    ; TARGET_CPU_PPC
  295.     IF TARGET_CPU_68K THEN
  296. ;
  297. ; pascal Boolean SwapInstructionCache(Boolean cacheEnable)
  298. ;
  299.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  300.         Macro
  301.         _SwapInstructionCache
  302.             moveq               #0,D0
  303.             dc.w                $A098
  304.         EndM
  305.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  306.         IMPORT_CFM_FUNCTION SwapInstructionCache
  307.     ENDIF
  308.  
  309. ;
  310. ; pascal void FlushInstructionCache(void )
  311. ;
  312.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  313.         Macro
  314.         _FlushInstructionCache
  315.             moveq               #1,D0
  316.             dc.w                $A098
  317.         EndM
  318.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  319.         IMPORT_CFM_FUNCTION FlushInstructionCache
  320.     ENDIF
  321.  
  322. ;
  323. ; pascal Boolean SwapDataCache(Boolean cacheEnable)
  324. ;
  325.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  326.         Macro
  327.         _SwapDataCache
  328.             moveq               #2,D0
  329.             dc.w                $A098
  330.         EndM
  331.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  332.         IMPORT_CFM_FUNCTION SwapDataCache
  333.     ENDIF
  334.  
  335. ;
  336. ; pascal void FlushDataCache(void )
  337. ;
  338.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  339.         Macro
  340.         _FlushDataCache
  341.             moveq               #3,D0
  342.             dc.w                $A098
  343.         EndM
  344.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  345.         IMPORT_CFM_FUNCTION FlushDataCache
  346.     ENDIF
  347.  
  348. ;
  349. ; pascal void FlushCodeCache(void )
  350. ;
  351.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  352.         _FlushCodeCache:    OPWORD    $A0BD
  353.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  354.         IMPORT_CFM_FUNCTION FlushCodeCache
  355.     ENDIF
  356.  
  357. ;
  358. ; pascal void FlushExternalCache(void )
  359. ;
  360.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  361.         Macro
  362.         _FlushExternalCache
  363.             moveq               #6,D0
  364.             dc.w                $A098
  365.         EndM
  366.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  367.         IMPORT_CFM_FUNCTION FlushExternalCache
  368.     ENDIF
  369.  
  370.     ENDIF    ; TARGET_CPU_68K
  371. ;
  372. ; pascal OSErr FlushCodeCacheRange(void *address, unsigned long count)
  373. ;
  374.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  375.         ; parameters:
  376.         ;    address         => A0
  377.         ;    count           => A1
  378.         ; returns:
  379.         ;    OSErr           <= D0
  380.         Macro
  381.         _FlushCodeCacheRange
  382.             moveq               #9,D0
  383.             dc.w                $A098
  384.         EndM
  385.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  386.         IMPORT_CFM_FUNCTION FlushCodeCacheRange
  387.     ENDIF
  388.  
  389. ;
  390. ; pascal void ReadLocation(MachineLocation *loc)
  391. ;
  392.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  393.         ; parameters:
  394.         ;    loc             => A0
  395.         Macro
  396.         _ReadLocation
  397.             move.l              #$000C00E4,D0
  398.             dc.w                $A051
  399.         EndM
  400.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  401.         IMPORT_CFM_FUNCTION ReadLocation
  402.     ENDIF
  403.  
  404.  
  405. ;
  406. ; pascal void WriteLocation(const MachineLocation *loc)
  407. ;
  408.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  409.         ; parameters:
  410.         ;    loc             => A0
  411.         Macro
  412.         _WriteLocation
  413.             move.l              #$000C00E4,D0
  414.             dc.w                $A052
  415.         EndM
  416.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  417.         IMPORT_CFM_FUNCTION WriteLocation
  418.     ENDIF
  419.  
  420.  
  421.  
  422.     IF OLDROUTINENAMES THEN
  423.     ENDIF    ; OLDROUTINENAMES
  424. ; 
  425. ;    NOTE: SysEnvirons is obsolete.  You should be using Gestalt.
  426. ;
  427.  
  428. ;  Environs Equates 
  429.  
  430. curSysEnvVers                    EQU        2                    ;Updated to equal latest SysEnvirons version
  431. SysEnvRec                RECORD 0
  432. environsVersion             ds.w    1                ; offset: $0 (0)
  433. machineType                 ds.w    1                ; offset: $2 (2)
  434. systemVersion             ds.w    1                ; offset: $4 (4)
  435. processor                 ds.w    1                ; offset: $6 (6)
  436. hasFPU                     ds.b    1                ; offset: $8 (8)
  437. hasColorQD                 ds.b    1                ; offset: $9 (9)
  438. keyBoardType             ds.w    1                ; offset: $A (10)
  439. atDrvrVersNum             ds.w    1                ; offset: $C (12)
  440. sysVRefNum                 ds.w    1                ; offset: $E (14)
  441. sizeof                     EQU *                    ; size:   $10 (16)
  442.                         ENDR
  443.  
  444.                                                             ; Machine Types 
  445. envMac                            EQU        -1
  446. envXL                            EQU        -2
  447. envMachUnknown                    EQU        0
  448. env512KE                        EQU        1
  449. envMacPlus                        EQU        2
  450. envSE                            EQU        3
  451. envMacII                        EQU        4
  452. envMacIIx                        EQU        5
  453. envMacIIcx                        EQU        6
  454. envSE30                            EQU        7
  455. envPortable                        EQU        8
  456. envMacIIci                        EQU        9
  457. envMacIIfx                        EQU        11
  458.  
  459.                                                             ; CPU types 
  460. envCPUUnknown                    EQU        0
  461. env68000                        EQU        1
  462. env68010                        EQU        2
  463. env68020                        EQU        3
  464. env68030                        EQU        4
  465. env68040                        EQU        5
  466.  
  467.                                                             ; Keyboard types 
  468. envUnknownKbd                    EQU        0
  469. envMacKbd                        EQU        1
  470. envMacAndPad                    EQU        2
  471. envMacPlusKbd                    EQU        3
  472. envAExtendKbd                    EQU        4
  473. envStandADBKbd                    EQU        5
  474. envPrtblADBKbd                    EQU        6
  475. envPrtblISOKbd                    EQU        7
  476. envStdISOADBKbd                    EQU        8
  477. envExtISOADBKbd                    EQU        9
  478. ;
  479. ; pascal OSErr SysEnvirons(short versionRequested, SysEnvRec *theWorld)
  480. ;
  481.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  482.         ; parameters:
  483.         ;    versionRequetheWorld=> D0
  484.         ;    theWorld        => A0
  485.         ; returns:
  486.         ;    OSErr           <= D0
  487.         _SysEnvirons:    OPWORD    $A090
  488.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  489.         IMPORT_CFM_FUNCTION SysEnvirons
  490.     ENDIF
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.     ENDIF ; __OSUTILS__ 
  498.  
  499.